Skip to main content

DescribeSearchCondition

Description

call DescribeSearchCondition to obtain filter criteria for query assets.

Request Method

POST

Request Path

/apsara/route/Sas/DescribeSearchCondition

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
TypeBODYstringNoecsthe asset type of the query. ecs : Indicates the filter criteria for querying all ECS servers. cloud_product : indicates the filter criteria for querying all cloud products.
SourceIpBODYstringNo1.2.3.4access the IP address of the source.
regionIdBODYstringYesNo sample value for this parameter.region id
LangBODYstringNozhthe language type of the request and receive message. zh: Chinese en: English
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
ConditionListarrayNo sample value for this parameter.filter condition information.
RequestIdstringNo sample value for this parameter.request ID of the result.
FilterConditionsstringNo sample value for this parameter.filter condition.
ConditionTypestringNo sample value for this parameter.condition type. Value: system: system default filter criteria user: user-defined filter criteria
NamestringNo sample value for this parameter.condition name.
NameKeystringNo sample value for this parameter.the key value of the condition name.

Example

Successful Response example

"The successful response sample is not recognizable. Please modify API definition in API gateway before re-create the API document."

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}